Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support socket mode #42

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Support socket mode #42

wants to merge 4 commits into from

Conversation

dummyx
Copy link

@dummyx dummyx commented Aug 16, 2022

Add support for socket mode in newer versions of bolt, which eliminates the need of a running http server.

It can be enabled through the command line switch "-s" or "--socket".

@docmarionum1
Copy link
Owner

Change looks good. Can you update the documentation (README.md) with how to use the new functionality?

@dummyx
Copy link
Author

dummyx commented Aug 17, 2022

Change looks good. Can you update the documentation (README.md) with how to use the new functionality?

OK, I'll work on it.

@dummyx
Copy link
Author

dummyx commented Aug 22, 2022

Change looks good. Can you update the documentation (README.md) with how to use the new functionality?

@docmarionum1 Added some minimal documentation for the socket mode.

@@ -102,6 +104,12 @@ to the query. The full usage is:
- Follow the installation steps above to create a new slack app with all of the required permissions and event subscriptions.
- The biggest change in requirements with the new version is the move from the [Real Time Messaging API](https://api.slack.com/rtm) to the [Events API](https://api.slack.com/apis/connections/events-api) which necessitates having a publicly-accessible url that Slack can send events to. If you are unable to serve a public endpoint, you can use [ngrok](https://ngrok.com/).

## Socket mode

To run the bot in socket mode, go to the app's "Socket Mode" page and enable it. Then add the app level token you got to environment variables.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To run the bot in socket mode, go to the app's "Socket Mode" page and enable it. Then add the app level token you got to environment variables.
To run the bot in socket mode, go to the app's "Socket Mode" page and enable it. Then add the app level token you got to environment variables under the name `SLACK_APP_TOKEN`.

Copy link
Owner

@docmarionum1 docmarionum1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a small suggested change for clarity in the readme. Otherwise looks good. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants